api(ImageBuf): IB::localpixels_as_[writable_]byte_image_span #5011
Conversation
Utilities to ask the IB for the local pixels as an untyped span of bytes. This is a "safe" alternative to `localpixels()`, which just returned a single pointer, instead returning an image_span that understands the sizes and strides of the buffer. Signed-off-by: Larry Gritz <lg@larrygritz.com>
|
Note: the bleeding edge test failure is not from this PR, it's due to a new commit in main of pybind11 that is causing things to crash. I have reported it. |
|
Any comments? |
| /// Return an `image_span<const std::byte>` giving the extent and layout | ||
| /// of "local" pixel memory, if they are fully in RAM and not backed by an | ||
| /// ImageCache, or an empty span otherwise. |
There was a problem hiding this comment.
[consider] It may be clearer to indicate that the return of this can be inferred from ImageBuf::storage. So for example:
Return an .. if ImageBuf::storage() is Storage::MEMORY`, otherwise ...
Apokogies if I botched that ayntax but hopefully the intention comes across
There was a problem hiding this comment.
I think I'm going to keep it as-is, because the storage test is actually a little more complicated than that. There are multiple storage() types that have addressable pixels, and multiple (at some point in the future, if not now) that do not. So I think keeping vague "if they are fully in RAM" is the distinction I'm trying to make.
2 participants
Utilities to ask the IB for the local pixels as an untyped span of bytes. This is a "safe" alternative to
localpixels(), which just returned a single pointer, instead returning an image_span that understands the sizes and strides of the buffer.